home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Vk / VkTextIO.z / VkTextIO
Encoding:
Text File  |  2002-10-03  |  7.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkTTTTeeeexxxxttttIIIIOOOO((((3333xxxx))))                                                      VVVVkkkkTTTTeeeexxxxttttIIIIOOOO((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkTextIO - Command-line interface text component
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkComponent : VkCallbackObject :
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkTextIO.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkTextIO(const char* name, Widget parent, const char* prompt = NULL);
  20.            virtual void ~VkTextIO(void);
  21.  
  22.  
  23.    DDDDiiiissssppppllllaaaayyyy FFFFuuuunnnnccccttttiiiioooonnnnssss
  24.            void clearHistory(void);
  25.            virtual void outputString(char* str,
  26.                                      Boolean skipInput = True);
  27.            void outputChar(char ch, Boolean skipInput);
  28.  
  29.  
  30.    CCCCoooonnnnttttrrrroooollll FFFFuuuunnnnccccttttiiiioooonnnnssss
  31.            void disableRedisplay(void);
  32.            void enableRedisplay(void);
  33.  
  34.  
  35.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  36.            Widget textWidget(void);
  37.            Boolean activated(void);
  38.            void activate(void);
  39.            void deactivate(void);
  40.  
  41.  
  42. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  43.      The VkTextIO class provides a text widget that the user interacts with as
  44.      if they were in a shell.  New entries appear at the end of the text
  45.      widget, and return sends a line to the controlling application.
  46.  
  47.  
  48.  
  49. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  50.    VVVVkkkkTTTTeeeexxxxttttIIIIOOOO(((())))
  51.            VkTextIO(const char* name, Widget parent,
  52.                     const char* prompt = NULL);
  53.            virtual void ~VkTextIO(void);
  54.  
  55.  
  56.           Creates a Motif scrolled text widget.  The first argument is the
  57.           name of the text widget, the second is the parent, and the third is
  58.           the prompt string displayed at the beginning of each line.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkTTTTeeeexxxxttttIIIIOOOO((((3333xxxx))))                                                      VVVVkkkkTTTTeeeexxxxttttIIIIOOOO((((3333xxxx))))
  71.  
  72.  
  73.  
  74.    cccclllleeeeaaaarrrrHHHHiiiissssttttoooorrrryyyy(((())))
  75.            void clearHistory(void);
  76.  
  77.  
  78.           Since the text widget contents cannot be edited by the user except
  79.           for the current line, the text contents grows without bound.  This
  80.           method clears the old history of the text widget.
  81.  
  82.    oooouuuuttttppppuuuuttttSSSSttttrrrriiiinnnngggg(((())))
  83.            virtual void outputString(char* str, Boolean skipInput);
  84.  
  85.  
  86.           Sends a line of output to the text widget.
  87.  
  88.    oooouuuuttttppppuuuuttttCCCChhhhaaaarrrr(((())))
  89.            void outputChar(char ch, Boolean skipInput);
  90.  
  91.  
  92.           Sends a character to the text widget.
  93.  
  94.    ddddiiiissssaaaabbbblllleeeeRRRReeeeddddiiiissssppppllllaaaayyyy(((())))
  95.            void disableRedisplay(void);
  96.  
  97.  
  98.           Turns of XmText display.  This is useful when you have a lot of
  99.           output to send in chunks, and don't want the overhead of text widget
  100.           updating between each incremental output.
  101.  
  102.    eeeennnnaaaabbbblllleeeeRRRReeeeddddiiiissssppppllllaaaayyyy(((())))
  103.            void enableRedisplay(void);
  104.  
  105.  
  106.           Turns on and update the XmText widget.  Call this method after
  107.           you're done calling outputString() or outputChar().
  108.  
  109.    tttteeeexxxxttttWWWWiiiiddddggggeeeetttt(((())))
  110.            Widget textWidget(void);
  111.  
  112.  
  113.           Returns the actual text widget of the component.  The baseWidget()
  114.           method returns the top-level scrolled window widget.
  115.  
  116.    aaaaccccttttiiiivvvvaaaatttteeeedddd(((())))
  117.           Boolean activated(void);
  118.  
  119.  
  120.           Indicates whether the component is active (sensitive).
  121.  
  122.    aaaaccccttttiiiivvvvaaaatttteeee(((())))
  123.           void activate(void);
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkTTTTeeeexxxxttttIIIIOOOO((((3333xxxx))))                                                      VVVVkkkkTTTTeeeexxxxttttIIIIOOOO((((3333xxxx))))
  137.  
  138.  
  139.  
  140.           Makes the component sensitive.
  141.  
  142.    ddddeeeeaaaaccccttttiiiivvvvaaaatttteeee(((())))
  143.           void deactivate(void);
  144.  
  145.  
  146.           Makes the component insensitive.
  147.  
  148.    tttteeeexxxxttttCCCCaaaallllllllbbbbaaaacccckkkk
  149.           static const const char* textCallback;
  150.  
  151.  
  152.           A callback function for detecting a new input line in the command-
  153.           line text widget or the user pressing CTRL-c.  The callData argument
  154.           should be cast to a (VkTextIOCallback *).
  155.  
  156. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  157.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  158.           className(),  installDestroyHandler(),  removeDestroyHandler(),
  159.           widgetDestroyed(), afterRealizeHook(),  setDefaultResources(),
  160.           getResources(),  VkComponent(),  VkComponent(), ~VkComponent(),
  161.           hide(),  realize(),  manage(),  unmanage(), name(),  baseWidget(),
  162.           okToQuit(),  isComponent(),  *(), _name,  _baseWidget,  _w,
  163.           deleteCallback,
  164.  
  165.  
  166.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  167.           callCallbacks(),  VkCallbackObject(),  ~VkCallbackObject(),
  168.           addCallback(),  addCallback(), removeCallback(),  removeCallback(),
  169.           removeAllCallbacks(),  removeAllCallbacks(),  hasCallbacks(),
  170.           cloneCallbacks(),  cloneCallback(),  cloneCallback(),
  171.  
  172.  
  173. KKKKNNNNOOOOWWWWNNNN DDDDEEEERRRRIIIIVVVVEEEEDDDD CCCCLLLLAAAASSSSSSSSEEEESSSS
  174.      VkForkIO
  175.  
  176. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  177.      VkComponent, VkCallbackObject, VkTextIO,
  178.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  179.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  180.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  181.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.